Inscoper::ParamDescription¶
ParamDescription class provides parameter information coming from drivers. More...
#include <ParamDescription.h>
Public Functions¶
| Name | |
|---|---|
| ParamDescription() =default Default constructor. |
|
| virtual | ~ParamDescription() =default Default destructor. |
| virtual unsigned short | getTag() const =0 Get the tag of the parameter. |
| virtual const std::string & | getName() const =0 Get the name of the parameter. |
| virtual const std::string & | getDescription() const =0 Get the description of the parameter. |
| virtual Inscoper::EParamType | getType() const =0 Get the type of the parameter. |
| virtual Inscoper::ConstraintPtr | getConstraint() =0 Get the constraints of the parameter. |
Detailed Description¶
ParamDescription class provides parameter information coming from drivers.
Note: This class is non-copyable and non-movable.
This class is an abstract base class storing device parameters, including their tag, name, description, and type.
Public Functions Documentation¶
function ParamDescription¶
Default constructor.
Initializes a new instance of the ParamDescription class.
function ~ParamDescription¶
Default destructor.
function getTag¶
Get the tag of the parameter.
Return: The tag of the parameter
Retrieves the unique tag of the parameter.
function getName¶
Get the name of the parameter.
Return: The name of the parameter
Retrieves the display name of the parameter.
function getDescription¶
Get the description of the parameter.
Return: The description of the parameter
Retrieves the textual description of the parameter.
function getType¶
Get the type of the parameter.
Return: The type of the parameter
Retrieves the data type of the parameter.
function getConstraint¶
Get the constraints of the parameter.
Return: The constraint of the parameter
Retrieves the constraints of the parameter (e.g. min, max, step size).
Updated on 2026-04-02 at 10:55:36 +0200